Saltar al contenido principal

Usuarios

Un usuario es un miembro de tu cuenta de Woofed CRM — típicamente un vendedor, un SDR o un account manager. Los usuarios son dueños de deals, ejecutan actividades y reciben asignaciones.

Estructura del recurso

AtributoTipoObligatorioEjemploNotas
emailstringSí (en creación)john.doe@example.comDebe ser un email válido.
passwordstringSí (en creación)StrongP@ssw0rdContraseña del usuario.
password_confirmationstringSí (en creación)StrongP@ssw0rdDebe coincidir con password.
full_namestringNoJohn DoeDefault vacío.
phonestringNo+5511999999999
languagestringNoenen, pt-BR, es, de. Default en.
avatar_urlstringNohttps://example.com/avatar.pngURL pública del avatar.
job_descriptionstringNosales_managerDefault other.
webpush_notify_on_event_expiredbooleanNotrueHabilita Web Push cuando un evento expira.

Todos los endpoints siguientes asumen:

{base_url} = https://app.woofedcrm.com
{account_id} = 1

Buscar usuarios

POST /api/v1/accounts/{account_id}/users/search

Busca usuarios con un objeto query al estilo Ransack. Consulta Estructura de la API → Búsqueda para la lista de predicados.

Body

{
"query": {
"full_name_cont": "John Acme",
"email_cont": "john.doe@example.com",
"phone_cont": "+1555",
"language_eq": "en",
"job_description_cont": "ceo",
"created_at_gteq": "2025-01-01T00:00:00Z",
"created_at_lteq": "2025-01-31T23:59:59Z",
"updated_at_gteq": "2025-01-10T00:00:00Z",
"id_eq": 123
}
}

Ejemplo de petición

curl -X POST "https://app.woofedcrm.com/api/v1/accounts/1/users/search" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TU_TOKEN_AQUÍ" \
-d '{
"query": {
"full_name_cont": "John",
"language_eq": "en"
}
}'

Ejemplo de respuesta — 200 OK

{
"data": [
{
"id": 123,
"full_name": "John Acme",
"email": "john.doe@example.com",
"created_at": "2025-01-12T18:21:03Z",
"updated_at": "2025-01-12T18:21:03Z",
"phone": "+15551234567",
"language": "en",
"notifications": { "webpush_notify_on_event_expired": true },
"avatar_url": "https://example.com/avatar.png",
"job_description": "ceo",
"theme_preference": "system",
"account_id": 1
}
],
"pagination": {
"page": 1,
"items": 1,
"count": 1,
"pages": 1,
"from": 1,
"last": 1,
"to": 1,
"prev": null,
"next": null
}
}

Posibles errores

StatusCuándo
400JSON mal formado.
401Token ausente o inválido.
422Predicado desconocido o campo no buscable.

Crear usuario

POST /api/v1/accounts/{account_id}/users

Crea un nuevo usuario dentro de la cuenta.

Body

{
"email": "tim@maia.com",
"password": "123456",
"password_confirmation": "123456",
"full_name": "Tim Maia",
"phone": "+5541996910256",
"language": "en",
"avatar_url": "https://example.com/avatars/tim-maia.png",
"job_description": "other",
"webpush_notify_on_event_expired": true
}

Ejemplo de petición

curl -X POST "https://app.woofedcrm.com/api/v1/accounts/1/users" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TU_TOKEN_AQUÍ" \
-d '{
"email": "tim@maia.com",
"password": "StrongP@ssw0rd",
"password_confirmation": "StrongP@ssw0rd",
"full_name": "Tim Maia",
"language": "es"
}'

Ejemplo de respuesta — 201 Created

{
"id": 9,
"full_name": "Tim Maia",
"email": "tim@maia.com",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z",
"phone": "+5541996910256",
"language": "es",
"notifications": { "webpush_notify_on_event_expired": true },
"avatar_url": "https://example.com/avatars/tim-maia.png",
"job_description": "other",
"theme_preference": "system",
"account_id": 1
}
Endpoint sensible

Crear usuarios concede acceso a la cuenta. Asegúrate de que el token usado para llamar a este endpoint pertenezca a un usuario admin, y nunca expongas esta llamada a un formulario público.

Posibles errores

StatusCuándo
401Token ausente o inválido.
422Email ya en uso, contraseña no coincide, u otro error de validación.